Bundling changes/improvements #1831

philipwalton · 2019-01-11T07:58:33Z

As a first step toward the changes proposed in #1830, I've updated the workbox-routing and workbox-core packages to give you an idea of what I'm thinking. If no one has any serious objections, I'll go ahead and update the rest of the packages as well.

The primary things I've done here are:

Remove all default exports
Move default export methods into their own files (exported individually)
Removed _public.mjs, _default.mjs, and browser.mjs files
Removed the log level code
Updated the build script with the changes
Moved the skipWaiting() and clientClaim() methods from workbox-sw to workbox-core (see here for rationale)
Deprecated the strategy functions in favor of using strategy classes (similar to how we do plugins).

R: @jeffposnick @gauntface

philipwalton · 2019-01-14T05:38:01Z

I finished updating the rest of the packages, and I updated all the tests accordingly.

I know this is a lot of changes to review, but overall I think these changes make our package structure much simpler. Also, it looks like it reduced our overall code size by more than 1KB (gzipped) from the previous PR. We're now in the 8KB range! 🎉

jeffposnick

Marking workbox.strategies.<strategyName> deprecated in favor of new workbox.strategies.StrategyName() is also a pretty big change that got rolled this PR, which wasn't included in the description. It's worth calling that out because we're going to have to communicate that in the release notes and update a bunch fo documentation examples.

packages/workbox-core/index.mjs

packages/workbox-precaching/utils/deleteOutdatedCaches.mjs

packages/workbox-precaching/utils/getOrCreatePrecacheController.mjs

packages/workbox-precaching/utils/precachePlugins.mjs

philipwalton · 2019-01-14T17:35:55Z

Marking workbox.strategies. deprecated in favor of new workbox.strategies.StrategyName() is also a pretty big change that got rolled this PR, which wasn't included in the description.

Ahh, sorry, I updated that in the proposal doc, but I forgot to also add it to the bullet points in this issue.

FWIW, I'm open to other options as well. Here are a few I think are find in a rough order of preference:

Switch to using constructors (e.g. new CacheFirst()) everywhere (like we do with plugins), but continue to support the old strategy functions for one major version and log a deprecation warning (what this PR does).
Keep the strategy functions and rename the strategy classes to something like CacheFirstStrategy (note we can't put them in a sub-folder because it would break the convention of keeping everything public in the top-level directory).
Consider the strategy classes private and only expose the strategy functions. (Someone would still extend a strategy class, they'd just have to instantiate one first, which is a bit awkward).

jeffposnick · 2019-01-14T18:24:10Z

I'm cool with moving to new workbox.strategies.StrategyName() in general. Having both ways of creating strategies has been a source of confusion in the past. My comment was mainly that we need to remember to call out that change, as it's going to be very visible to users.

workbox/packages/workbox-build/src/lib/runtime-caching-converter.js

Lines 144 to 145 in b8eb5a2

    
           const strategyString = 
        
             `workbox.strategies.${entry.handler}(${optionsString})`;

should also get updated to use the constructor syntax. This PR is already large enough, so that could be deferred until after this PR is merged.

philipwalton · 2019-01-14T18:37:04Z

Ok, I can address that in a new PR. The rest of the stuff you mentioned has been updated.

workbox-pr-bot · 2019-01-14T18:52:07Z

PR-Bot Size Plugin

Changed File Sizes

File	Before	After	Change	GZipped
packages/workbox-background-sync/build/workbox-background-sync.prod.js	3.51 KB	3.59 KB	+2%	1.56 KB
packages/workbox-broadcast-cache-update/build/workbox-broadcast-cache-update.prod.js	1.12 KB	1.88 KB	+68%	940 B	☠️
packages/workbox-build/build/index.js	4.02 KB	3.64 KB	-9%	1.36 KB
packages/workbox-cache-expiration/build/workbox-cache-expiration.prod.js	3.88 KB	3.15 KB	-19%	1.28 KB	🎉
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js	587 B	594 B	+1%	350 B
packages/workbox-cli/build/app.js	6.76 KB	5.58 KB	-17%	1.98 KB	🎉
packages/workbox-cli/build/bin.js	2.32 KB	1.16 KB	-50%	580 B	🎉
packages/workbox-core/build/workbox-core.prod.js	7.47 KB	5.51 KB	-26%	2.38 KB	🎉
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js	660 B	667 B	+1%	323 B
packages/workbox-precaching/build/workbox-precaching.prod.js	5.80 KB	4.20 KB	-28%	1.68 KB	🎉
packages/workbox-range-requests/build/workbox-range-requests.prod.js	1.63 KB	1.53 KB	-6%	764 B
packages/workbox-routing/build/workbox-routing.prod.js	2.87 KB	3.22 KB	+12%	1.41 KB	☠️
packages/workbox-strategies/build/workbox-strategies.prod.js	5.09 KB	4.87 KB	-4%	1.19 KB
packages/workbox-streams/build/workbox-streams.prod.js	1.57 KB	1.39 KB	-12%	683 B	🎉
packages/workbox-sw/build/workbox-sw.js	1.50 KB	1.36 KB	-9%	748 B
packages/workbox-webpack-plugin/build/generate-sw.js	8.04 KB	5.29 KB	-34%	1.84 KB	🎉
packages/workbox-webpack-plugin/build/index.js	742 B	349 B	-53%	255 B	🎉
packages/workbox-webpack-plugin/build/inject-manifest.js	10.30 KB	6.91 KB	-33%	2.40 KB	🎉

New Files

File	Size	GZipped
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js	1.74 KB	877 B

All File Sizes

View Table

File	Before	After	Change	GZipped
packages/workbox-background-sync/build/workbox-background-sync.prod.js	3.51 KB	3.59 KB	+2%	1.56 KB
packages/workbox-broadcast-cache-update/build/workbox-broadcast-cache-update.prod.js	1.12 KB	1.88 KB	+68%	940 B	☠️
packages/workbox-build/build/_types.js	41 B	41 B	0%	61 B
packages/workbox-build/build/index.js	4.02 KB	3.64 KB	-9%	1.36 KB
packages/workbox-cache-expiration/build/workbox-cache-expiration.prod.js	3.88 KB	3.15 KB	-19%	1.28 KB	🎉
packages/workbox-cacheable-response/build/workbox-cacheable-response.prod.js	587 B	594 B	+1%	350 B
packages/workbox-cli/build/app.js	6.76 KB	5.58 KB	-17%	1.98 KB	🎉
packages/workbox-cli/build/bin.js	2.32 KB	1.16 KB	-50%	580 B	🎉
packages/workbox-core/build/workbox-core.prod.js	7.47 KB	5.51 KB	-26%	2.38 KB	🎉
packages/workbox-google-analytics/build/workbox-offline-ga.prod.js		1.74 KB		877 B
packages/workbox-navigation-preload/build/workbox-navigation-preload.prod.js	660 B	667 B	+1%	323 B
packages/workbox-precaching/build/workbox-precaching.prod.js	5.80 KB	4.20 KB	-28%	1.68 KB	🎉
packages/workbox-range-requests/build/workbox-range-requests.prod.js	1.63 KB	1.53 KB	-6%	764 B
packages/workbox-routing/build/workbox-routing.prod.js	2.87 KB	3.22 KB	+12%	1.41 KB	☠️
packages/workbox-strategies/build/workbox-strategies.prod.js	5.09 KB	4.87 KB	-4%	1.19 KB
packages/workbox-streams/build/workbox-streams.prod.js	1.57 KB	1.39 KB	-12%	683 B	🎉
packages/workbox-sw/build/workbox-sw.js	1.50 KB	1.36 KB	-9%	748 B
packages/workbox-webpack-plugin/build/generate-sw.js	8.04 KB	5.29 KB	-34%	1.84 KB	🎉
packages/workbox-webpack-plugin/build/index.js	742 B	349 B	-53%	255 B	🎉
packages/workbox-webpack-plugin/build/inject-manifest.js	10.30 KB	6.91 KB	-33%	2.40 KB	🎉

Workbox Aggregate Size Plugin

8.83KB gzip'ed (59% of limit)
22.38KB uncompressed

philipwalton requested a review from jeffposnick January 11, 2019 07:58

philipwalton changed the title ~~Exports update~~ Bundling changes/improvements Jan 11, 2019

philipwalton added 5 commits January 11, 2019 12:50

Remove default exports from workbox-routing

35069bf

Update workbox-core to new conventions

9e2bcfc

Update the build task for the new conventions

22019ac

Revert trivial changes

43dbfe0

Update all other packages to the new conventions

295228f

philipwalton force-pushed the exports-update branch from 5a90a5c to 295228f Compare January 12, 2019 06:26

philipwalton added 5 commits January 13, 2019 12:37

Update unit tests for changes

390f16c

Update integration tests for changes

8532b44

Fix failing build

39940b1

Fix failing integration test

c916539

Fix failing appveyor builds

b764608

philipwalton mentioned this pull request Jan 13, 2019

Fixes for workbox-precaching issues in recent PRs #1835

Merged

jeffposnick suggested changes Jan 14, 2019

View reviewed changes

Address review feedback

1d546d8

jeffposnick approved these changes Jan 14, 2019

View reviewed changes

philipwalton merged commit d0d8f97 into next Jan 14, 2019

jeffposnick mentioned this pull request Feb 12, 2019

setDefaultHandler/setCatchHandler need to be exposed on workbox.routing #1897

Closed

philipwalton mentioned this pull request Apr 23, 2019

More control over enabling/disabling debug logging #1619

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundling changes/improvements #1831

Bundling changes/improvements #1831

philipwalton commented Jan 11, 2019 •

edited

Loading

philipwalton commented Jan 14, 2019

jeffposnick left a comment

philipwalton commented Jan 14, 2019

jeffposnick commented Jan 14, 2019

philipwalton commented Jan 14, 2019

workbox-pr-bot commented Jan 14, 2019

Bundling changes/improvements #1831

Bundling changes/improvements #1831

Conversation

philipwalton commented Jan 11, 2019 • edited Loading

philipwalton commented Jan 14, 2019

jeffposnick left a comment

Choose a reason for hiding this comment

philipwalton commented Jan 14, 2019

jeffposnick commented Jan 14, 2019

philipwalton commented Jan 14, 2019

workbox-pr-bot commented Jan 14, 2019

PR-Bot Size Plugin

Changed File Sizes

New Files

All File Sizes

Workbox Aggregate Size Plugin

philipwalton commented Jan 11, 2019 •

edited

Loading